/**
 * =================================================================
 * 版权所有 2011-2013 深圳市泰海网络科技服务有限公司，并保留所有权利
 * -----------------------------------------------------------------
 * 这不是一个自由软件！您不能在任何未经允许的前提下对程序代码进行修改和使用；
 * 不允许对程序代码以任何形式任何目的的再发布
 * =================================================================
 */
package com.sfpay.api;

import java.util.Map;

/**
 * 类说明：<br>
 * 
 * <p>
 * 详细描述：<br>
 * 
 * </p>
 * 
 * <pre>
 * ——————————————————————————————————————————————————————————————————
 * |		修改人		|		修改时间			|		修改原因
 * ——————————————————————————————————————————————————————————————————
 * |	zengxx 曾宪新	|		2013-8-18		|	
 * ——————————————————————————————————————————————————————————————————
 * </pre>
 * 
 * @author zengxx 曾宪新(Xavier.zeng)
 * 
 *         CreateDate: 2013-8-18
 */
public interface SfpayRequest<T extends SfpayResponse> {

	/**
	 * 方法说明：获取SFP的API名称。
	 * 
	 * @return API名称
	 */
	public String getApiMethodName();

	/**
	 * 方法说明：获取所有的Key-Value形式的文本请求参数集合。其中：
	 * <ul>
	 * <li>Key: 请求参数名</li>
	 * <li>Value: 请求参数值</li>
	 * </ul>
	 * 
	 * @return 文本请求参数集合
	 */
	public Map<String, String> getTextParams();

	/**
	 * 方法说明：指定或默认的时间戳
	 * 
	 * @return
	 */
	public Long getTimestamp();

	/**
	 * 方法说明：设置时间戳，如果不设置,发送请求时将使用当时的时间。
	 * 
	 * @param timestamp
	 *            时间戳
	 */
	public void setTimestamp(Long timestamp);

	/**
	 * 方法说明：请求类CLASS<br>
	 * 
	 * @return
	 */
	public Class<T> getResponseClass();

	/**
	 * 方法说明：客户端参数检查，减少服务端无效调用
	 */
	public void check() throws ApiRuleException;

	/**
	 * 方法说明：添加HTTP请求头参数
	 */
	public Map<String, String> getHeaderMap();

	/**
	 * 方法说明：添加自定义请求参数
	 */
	public void putOtherTextParam(String key, String value);
}
